<?xml version="1.0" encoding="iso-8859-1"?>
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
  <html xmlns="http://www.w3.org/1999/xhtml">
		<head>
			<!-- template designed by Marco Von Ballmoos -->
			<title>Docs For Class Services_WorkXpress_Request</title>
			<link rel="stylesheet" href="../media/stylesheet.css" />
			<meta http-equiv='Content-Type' content='text/html; charset=iso-8859-1'/>
		</head>
		<body>
			<div class="page-body">			
<h2 class="class-name">Class Services_WorkXpress_Request</h2>

<a name="sec-description"></a>
<div class="info-box">
	<div class="info-box-title">Description</div>
	<div class="nav-bar">
					<span class="disabled">Description</span> |
							<a href="#sec-descendents">Descendents</a>
			|											<a href="#sec-var-summary">Vars</a> (<a href="#sec-vars">details</a>)
						|											<a href="#sec-method-summary">Methods</a> (<a href="#sec-methods">details</a>)
						
					</div>
	<div class="info-box-body">
        		<!-- ========== Info from phpDoc block ========= -->
<p class="short-description">Base class for all requests</p>
<p class="description"><p>PHP version 5</p></p>
	<ul class="tags">
				<li><span class="field">link:</span> PACKAGE_URL</li>
				<li><span class="field">license:</span> <a href="http://www.opensource.org/licenses/bsd-license.php">BSD License</a></li>
				<li><span class="field">copyright:</span> 2005-2006 Express Dynamics</li>
				<li><span class="field">author:</span> Scott Gonzalez &lt;<a href="mailto:sgonzalez@expressdynamics.com">sgonzalez@expressdynamics.com</a>&gt;</li>
			</ul>
		<p class="notes">
			Located in <a class="field" href="_WorkXpress---Request.php.html">/WorkXpress/Request.php</a> (line <span class="field">56</span>)
		</p>
		
				
		<pre></pre>
	
			</div>
</div>

	<a name="sec-descendents"></a>
	<div class="info-box">
		<div class="info-box-title">Direct descendents</div>
		<div class="nav-bar">
			<a href="#sec-description">Description</a> |
			<span class="disabled">Descendents</span>
			|												<a href="#sec-var-summary">Vars</a> (<a href="#sec-vars">details</a>)
								|															<a href="#sec-method-summary">Methods</a> (<a href="#sec-methods">details</a>)
							
								</div>
		<div class="info-box-body">
			<table cellpadding="2" cellspacing="0" class="class-table">
				<tr>
					<th class="class-table-header">Class</th>
					<th class="class-table-header">Description</th>
				</tr>
								<tr>
					<td style="padding-right: 2em"><a href="../Services_WorkXpress/Services_WorkXpress_Request_ExecuteBusinessRulesMass.html">Services_WorkXpress_Request_ExecuteBusinessRulesMass</a></td>
					<td>
											Request class for the ExecuteBusinessRulesMass API function (mass format)
										</td>
				</tr>
								<tr>
					<td style="padding-right: 2em"><a href="../Services_WorkXpress/Services_WorkXpress_Request_ExecuteBusinessRules.html">Services_WorkXpress_Request_ExecuteBusinessRules</a></td>
					<td>
											Request class for the ExecuteBusinessRules API function
										</td>
				</tr>
								<tr>
					<td style="padding-right: 2em"><a href="../Services_WorkXpress/Services_WorkXpress_Request_StoreItemDataMass.html">Services_WorkXpress_Request_StoreItemDataMass</a></td>
					<td>
											Request class for the StoreItemData API function (mass format)
										</td>
				</tr>
								<tr>
					<td style="padding-right: 2em"><a href="../Services_WorkXpress/Services_WorkXpress_Request_AddNewItemMass.html">Services_WorkXpress_Request_AddNewItemMass</a></td>
					<td>
											Request class for the AddNewItem API function (mass format)
										</td>
				</tr>
								<tr>
					<td style="padding-right: 2em"><a href="../Services_WorkXpress/Services_WorkXpress_Request_AddNewItem.html">Services_WorkXpress_Request_AddNewItem</a></td>
					<td>
											Request class for the AddNewItem API function
										</td>
				</tr>
								<tr>
					<td style="padding-right: 2em"><a href="../Services_WorkXpress/Services_WorkXpress_Request_LookupData.html">Services_WorkXpress_Request_LookupData</a></td>
					<td>
											request class for the LookupData API function
										</td>
				</tr>
								<tr>
					<td style="padding-right: 2em"><a href="../Services_WorkXpress/Services_WorkXpress_Request_StoreItemData.html">Services_WorkXpress_Request_StoreItemData</a></td>
					<td>
											Request class for the StoreItemData API function
										</td>
				</tr>
								<tr>
					<td style="padding-right: 2em"><a href="../Services_WorkXpress/Services_WorkXpress_Request_LookupDataMass.html">Services_WorkXpress_Request_LookupDataMass</a></td>
					<td>
											Request class for the LookupData API function (mass format)
										</td>
				</tr>
							</table>
		</div>
	</div>


	<a name="sec-var-summary"></a>
	<div class="info-box">
		<div class="info-box-title">Variable Summary</span></div>
		<div class="nav-bar">
			<a href="#sec-description">Description</a> |
							<a href="#sec-descendents">Descendents</a> |
						<span class="disabled">Vars</span> (<a href="#sec-vars">details</a>)
							| 
									<a href="#sec-method-summary">Methods</a> (<a href="#sec-methods">details</a>)
							
								</div>
		<div class="info-box-body">
			<div class="var-summary">
																																								<div class="var-title">
					<span class="var-type">mixed</span>
					<a href="#$dom" title="details" class="var-name">$dom</a>
				</div>
																<div class="var-title">
					<span class="var-type">mixed</span>
					<a href="#$props" title="details" class="var-name">$props</a>
				</div>
																<div class="var-title">
					<span class="var-type">mixed</span>
					<a href="#$request" title="details" class="var-name">$request</a>
				</div>
											</div>
		</div>
	</div>

	<a name="sec-method-summary"></a>
	<div class="info-box">
		<div class="info-box-title">Method Summary</span></div>
		<div class="nav-bar">
			<a href="#sec-description">Description</a> |
							<a href="#sec-descendents">Descendents</a> |
																		<a href="#sec-var-summary">Vars</a> (<a href="#sec-vars">details</a>)
				 
				|
						<span class="disabled">Methods</span> (<a href="#sec-methods">details</a>)
		</div>
		<div class="info-box-body">			
			<div class="method-summary">
																																				
												<div class="method-definition">
											<span class="method-result">Services_WorkXpress_Request</span>
										<a href="#__construct" title="details" class="method-name">__construct</a>
											(<span class="var-type">array</span>&nbsp;<span class="var-name">$props</span>)
									</div>
																<div class="method-definition">
											<span class="method-result">void</span>
										<a href="#call" title="details" class="method-name">call</a>
										()
									</div>
																<div class="method-definition">
											<span class="method-result">void</span>
										<a href="#setXML" title="details" class="method-name">setXML</a>
											(<span class="var-type">string</span>&nbsp;<span class="var-name">$xml</span>)
									</div>
																<div class="method-definition">
											<span class="method-result">string</span>
										<a href="#__toString" title="details" class="method-name">__toString</a>
										()
									</div>
								</div>
		</div>
	</div>		

	<a name="sec-vars"></a>
	<div class="info-box">
		<div class="info-box-title">Variables</div>
		<div class="nav-bar">
			<a href="#sec-description">Description</a> |
							<a href="#sec-descendents">Descendents</a> |
										<a href="#sec-var-summary">Vars</a> (<span class="disabled">details</span>)
						
			
										| 
									<a href="#sec-method-summary">Methods</a> (<a href="#sec-methods">details</a>)
							
					</div>
		<div class="info-box-body">
			<a name="var$dom" id="$dom"><!-- --></A>
<div class="oddrow">

	<div class="var-header">
		<span class="var-title">
			<span class="var-type">mixed</span>
			<span class="var-name">$dom</span>
						(line <span class="line-number">66</span>)
		</span>
	</div>

	<!-- ========== Info from phpDoc block ========= -->
<p class="short-description">request XML DOM document</p>
	<ul class="tags">
				<li><span class="field">access:</span> protected</li>
			</ul>
	
	
		
		

</div>
<a name="var$props" id="$props"><!-- --></A>
<div class="evenrow">

	<div class="var-header">
		<span class="var-title">
			<span class="var-type">mixed</span>
			<span class="var-name">$props</span>
						(line <span class="line-number">61</span>)
		</span>
	</div>

	<!-- ========== Info from phpDoc block ========= -->
<p class="short-description">WorkXpress API properties</p>
	<ul class="tags">
				<li><span class="field">access:</span> protected</li>
			</ul>
	
	
		
		

</div>
<a name="var$request" id="$request"><!-- --></A>
<div class="oddrow">

	<div class="var-header">
		<span class="var-title">
			<span class="var-type">mixed</span>
			<span class="var-name">$request</span>
						(line <span class="line-number">71</span>)
		</span>
	</div>

	<!-- ========== Info from phpDoc block ========= -->
<p class="short-description">wx_request element in the DOM document</p>
	<ul class="tags">
				<li><span class="field">access:</span> protected</li>
			</ul>
	
	
		
		

</div>
						
		</div>
	</div>
	
	<a name="sec-methods"></a>
	<div class="info-box">
		<div class="info-box-title">Methods</div>
		<div class="nav-bar">
			<a href="#sec-description">Description</a> |
							<a href="#sec-descendents">Descendents</a> |
															<a href="#sec-var-summary">Vars</a> (<a href="#sec-vars">details</a>)
																	<a href="#sec-method-summary">Methods</a> (<span class="disabled">details</span>)
						
		</div>
		<div class="info-box-body">
			<A NAME='method_detail'></A>

<a name="method__construct" id="__construct"><!-- --></a>
<div class="evenrow">
	
	<div class="method-header">
		<span class="method-title">Constructor __construct</span> (line <span class="line-number">78</span>)
	</div> 
	
	<!-- ========== Info from phpDoc block ========= -->
<p class="short-description">Constructor</p>
	<ul class="tags">
				<li><span class="field">access:</span> public</li>
			</ul>
	
	<div class="method-signature">
		<span class="method-result">Services_WorkXpress_Request</span>
		<span class="method-name">
			__construct
		</span>
					(<span class="var-type">array</span>&nbsp;<span class="var-name">$props</span>)
			</div>
	
			<ul class="parameters">
					<li>
				<span class="var-type">array</span>
				<span class="var-name">$props</span><span class="var-description">: WorkXpress API properties</span>			</li>
				</ul>
		
			
			<hr class="separator" />
		<div class="notes">Redefined in descendants as:</div>
		<ul class="redefinitions">
					<li>
				<a href="../Services_WorkXpress/Services_WorkXpress_Request_ExecuteBusinessRulesMass.html#method__construct">Services_WorkXpress_Request_ExecuteBusinessRulesMass::__construct()</a>
								: Constructor
							</li>
					<li>
				<a href="../Services_WorkXpress/Services_WorkXpress_Request_ExecuteBusinessRules.html#method__construct">Services_WorkXpress_Request_ExecuteBusinessRules::__construct()</a>
								: Constructor
							</li>
					<li>
				<a href="../Services_WorkXpress/Services_WorkXpress_Request_StoreItemDataMass.html#method__construct">Services_WorkXpress_Request_StoreItemDataMass::__construct()</a>
								: Constructor
							</li>
					<li>
				<a href="../Services_WorkXpress/Services_WorkXpress_Request_AddNewItemMass.html#method__construct">Services_WorkXpress_Request_AddNewItemMass::__construct()</a>
								: Constructor
							</li>
					<li>
				<a href="../Services_WorkXpress/Services_WorkXpress_Request_AddNewItem.html#method__construct">Services_WorkXpress_Request_AddNewItem::__construct()</a>
								: Constructor
							</li>
					<li>
				<a href="../Services_WorkXpress/Services_WorkXpress_Request_LookupData.html#method__construct">Services_WorkXpress_Request_LookupData::__construct()</a>
								: Constructor
							</li>
					<li>
				<a href="../Services_WorkXpress/Services_WorkXpress_Request_StoreItemData.html#method__construct">Services_WorkXpress_Request_StoreItemData::__construct()</a>
								: Constructor
							</li>
					<li>
				<a href="../Services_WorkXpress/Services_WorkXpress_Request_LookupDataMass.html#method__construct">Services_WorkXpress_Request_LookupDataMass::__construct()</a>
								: Constructor
							</li>
				</ul>
	</div>
<a name="methodcall" id="call"><!-- --></a>
<div class="oddrow">
	
	<div class="method-header">
		<span class="method-title">call</span> (line <span class="line-number">109</span>)
	</div> 
	
	<!-- ========== Info from phpDoc block ========= -->
<p class="short-description">Executes the API call</p>
	<ul class="tags">
				<li><span class="field">access:</span> public</li>
			</ul>
	
	<div class="method-signature">
		<span class="method-result">void</span>
		<span class="method-name">
			call
		</span>
				()
			</div>
	
		
			
	</div>
<a name="methodsetXML" id="setXML"><!-- --></a>
<div class="evenrow">
	
	<div class="method-header">
		<span class="method-title">setXML</span> (line <span class="line-number">154</span>)
	</div> 
	
	<!-- ========== Info from phpDoc block ========= -->
<p class="short-description">Sets the request XML</p>
<p class="description"><p>This overrides any XML that has alrady been set for the request.</p></p>
	<ul class="tags">
				<li><span class="field">access:</span> public</li>
			</ul>
	
	<div class="method-signature">
		<span class="method-result">void</span>
		<span class="method-name">
			setXML
		</span>
					(<span class="var-type">string</span>&nbsp;<span class="var-name">$xml</span>)
			</div>
	
			<ul class="parameters">
					<li>
				<span class="var-type">string</span>
				<span class="var-name">$xml</span><span class="var-description">: request XML</span>			</li>
				</ul>
		
			
	</div>
<a name="method__toString" id="__toString"><!-- --></a>
<div class="oddrow">
	
	<div class="method-header">
		<span class="method-title">__toString</span> (line <span class="line-number">101</span>)
	</div> 
	
	<!-- ========== Info from phpDoc block ========= -->
<p class="short-description">Gets the string representation of the request</p>
<p class="description"><p>Uses the XML that would be passed to the WorkXpress API as the output.</p></p>
	<ul class="tags">
				<li><span class="field">return:</span> XML that would be passed to the WorkXpress API</li>
				<li><span class="field">access:</span> public</li>
			</ul>
	
	<div class="method-signature">
		<span class="method-result">string</span>
		<span class="method-name">
			__toString
		</span>
				()
			</div>
	
		
			
	</div>
						
		</div>
	</div>


	<p class="notes" id="credit">
		Documentation generated on Wed, 22 Nov 2006 11:54:01 -0500 by <a href="http://www.phpdoc.org" target="_blank">phpDocumentor 1.3.1</a>
	</p>
	</div></body>
</html>